Appliance LocalAccounts Config

Appliance LocalAccounts Config
Appliance LocalAccounts Config

The Appliance LocalAccounts Config schema defines the information required for the account.

This schema was added in vSphere API 6.7.

JSON Example
{
    "password": "string",
    "old_password": "string",
    "full_name": "string",
    "email": "string",
    "roles": [
        "string"
    ],
    "enabled": false,
    "password_expires": false,
    "password_expires_at": "string",
    "inactive_after_password_expiration": false,
    "days_after_password_expiration": 0,
    "min_days_between_password_change": 0,
    "max_days_between_password_change": 0,
    "warn_days_before_password_expiration": 0
}
string As password As password
password
Required

Password

This property was added in vSphere API 6.7.

string As password As password
old_password
Optional

Old password of the user (required in case of the password change, not required if superAdmin user changes the password of the other user)

This property was added in vSphere API 6.7.

If missing or null, user may not have password set.

string
full_name
Optional

Full name of the user

This property was added in vSphere API 6.7.

If missing or null, user will have no fullname.

string
email
Optional

Email address of the local account

This property was added in vSphere API 6.7.

If missing or null, user will have no email.

array of string
roles
Required

User roles

This property was added in vSphere API 6.7.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.appliance.roles. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.appliance.roles.

boolean
enabled
Optional

Flag indicating if the account is enabled

This property was added in vSphere API 6.7.

If missing or null, defaults to True

boolean
password_expires
Optional

Flag indicating if the account password expires

This property was added in vSphere API 6.7.

If missing or null, defaults to True.

string As date-time As date-time
password_expires_at
Optional

Date when the account's password will expire

This property was added in vSphere API 6.7.

If missing or null, will be taken from system defaults (see local-accounts/policy).

boolean
inactive_after_password_expiration
Optional

Flag indicating if the account will be locked after password expiration

This property was added in vSphere API 6.7.

If missing or null, defaults to True.

integer As int64 As int64
days_after_password_expiration
Optional

Number of days after password expiration before the account will be locked

This property was added in vSphere API 6.7.

If missing or null, will be taken from system defaults (see local-accounts/policy).

integer As int64 As int64
min_days_between_password_change
Optional

Minimum number of days between password change

This property was added in vSphere API 6.7.

If missing or null, will be taken from system defaults (see local-accounts/policy).

integer As int64 As int64
max_days_between_password_change
Optional

Maximum number of days between password change

This property was added in vSphere API 6.7.

If missing or null, will be taken from system defaults (see local-accounts/policy).

integer As int64 As int64
warn_days_before_password_expiration
Optional

Number of days of warning before password expires

This property was added in vSphere API 6.7.

If missing or null, will be taken from system defaults (see local-accounts/policy).

Parameter To